pywikipedia.catlib.

Package pywikipedia :: Module catlib :: Class _Category

[show private | hide private]

Type _Category

object --+    
         |    
      Page --+
             |
            _Category

Subclass of Page that has some special tricks that only work for category: pages

Method Summary
	`_make_catlist(self, recurse, purge, site)` Make a list of all articles and categories that are in this category.
	`articles(self, recurse)` Create a list of all pages in the current category.
	`catlist(self, recurse, purge)` Cache result of make_catlist for a second call
	`copyTo(self, catname)` Returns true if copying was successful, false if target page already existed.
	`iscattitle(self, title)`
	`isEmpty(self)` True if the page except for language links and category links has less than 4 characters, False otherwise.
	`subcategories(self, recurse)` Create a list of all subcategories of the current category.
	`supercategories(self, recurse)` Create a list of all subcategories of the current category.
Inherited from Page
	`__init__(self, site, title, insite, tosite)` Constructor.
	`__cmp__(self, other)` Pseudo method to be able to use equality and inequality tests on Page objects
	`__hash__(self)` Pseudo method that makes it possible to store Page objects as keys in hash-tables.
	`__repr__(self)` A more complete string representation
	`__str__(self)` A console representation of the pagelink
	`aslink(self, forceInterwiki)` A string representation in the form of a link.
	`categories(self)` A list of categories that the article is in.
	`catname(self, doublex)` The name of the page without the namespace part.
	`contributingUsers(self)` Returns a set of all user names (including anonymous IPs) of those who edited the page.
	`delete(pl, reason, prompt)` Deletes the page from the wiki.
	`encoding(self)` Returns the character encoding used on this page's wiki.
	`exists(self)` True if the page exists (itself or as redirect), False if not
	`get(self, read_only, force, get_redirect, throttle)` The wiki-text of the page.
	`getRedirectTarget(self, read_only)` If the page is a redirect page, gives the title of the page it redirects to.
	`getReferences(self, follow_redirects)` Returns a list of pages that link to the page.
	`getVersionHistory(self, forceReload)` Loads the version history page and returns a list of tuples, where each tuple represents one edit and is built of edit date/time, user name, and edit summary.
	`imagelinks(self)` Gives the wiki-images the page shows, as a list of pagelink objects
	`interwiki(self)` A list of interwiki links in the page.
	`isCategory(self)` True if the page is a Category, false otherwise.
	`isDisambig(self)`
	`isImage(self)` True if the page is an Image description page, false otherwise.
	`isRedirectPage(self)` True if the page is a redirect page, False if not or not existing
	`linkedPages(self)` Gives the normal (not-interwiki, non-category) pages the page links to, as a list of Page objects
	`linkname(self, doublex)` The name of the page this Page refers to, in a form suitable for a wiki-link
	`namespace(self)` Gives the number of the namespace of the page.
	`put(self, newtext, comment, watchArticle, minorEdit)` Replace the new page with the contents of the first argument.
	`rawcategories(self)` Just like categories, but gives the categories including the part after the \|, if any.
	`section(self)` The name of the section this Page refers to.
	`sectionFreeLinkname(self, doublex)`
	`site(self)` The site of the page this Page refers to, without :
	`templates(self)` Gives a list of template names used on a page (strings).
	`urlname(self)` The name of the page this Page refers to, in a form suitable for the URL of the page.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value

Method Details

_make_catlist(self, recurse=False, purge=False, site=None)

Make a list of all articles and categories that are in this category. If recurse is set to True, articles and subcategories of any subcategories are also retrieved.

Returns non-unique, non-sorted lists of articles, subcategories and supercategories. The supercategory list only contains the supercategories of this category, regardless of the recurse argument.

This should not be used outside of this module.

articles(self, recurse=False)

Create a list of all pages in the current category.

If recurse = True, also return pages in all subcategories.

Returns a sorted, unique list of all categories.

catlist(self, recurse=False, purge=False)

Cache result of make_catlist for a second call

This should not be used outside of this module.

copyTo(self, catname)

Returns true if copying was successful, false if target page already existed.

isEmpty(self)

True if the page except for language links and category links has less than 4 characters, False otherwise. Can return the same exceptions as get()

Overrides:: pywikipedia.wikipedia.Page.isEmpty (inherited documentation)

subcategories(self, recurse=False)

Create a list of all subcategories of the current category.

If recurse = True, also return subcategories of the subcategories.

Returns a sorted, unique list of all subcategories.

supercategories(self, recurse=False)

Create a list of all subcategories of the current category.

If recurse = True, also return subcategories of the subcategories.

Returns a sorted, unique list of all subcategories.

Generated by Epydoc 2.1 on Sun Jul 03 17:07:36 2005

http://epydoc.sf.net